[Internal] Skip integration tests on docs-only changes #4165
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| steps: | ||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Check if all changes are in docs/ directory |
There was a problem hiding this comment.
There is an action to that does the grep for you.
- uses: dorny/paths-filter@v3
id: changes
with:
filters: |
integration_tests_required:
- '**/*'
- '!docs/**'
needs: [changes]
if: '{{ needs.changes.outputs.integration_tests_required == "true" }}'
| auto-approve: | ||
| if: github.event_name == 'merge_group' | ||
| needs: check-integration-test-changes | ||
| if: '{{ github.event_name == "merge_group" || env.integration_tests_required == "false" }}' |
There was a problem hiding this comment.
Actually, this won't work in the merge queue. If the "need" job is skipped, this will be skipped too (even with the "if" condition). You can use always() to ensure it runs. Also, use the output
if: always() && (github.event_name == 'merge_group' || needs.check-integration-test-changes.outputs.integration_tests_required == 'true')
|
|
||
| trigger-tests: | ||
| needs: check-integration-test-changes | ||
| if: '{{ env.integration_tests_required == "true" }}' |
There was a problem hiding this comment.
It's an output, not an env.
Define the output and set an id for the job
jobs:
changes:
runs-on: ubuntu-latest
outputs: <----
integration_tests_required: ${{ steps.filter.outputs.integration_tests_required }}
steps:
- uses: actions/checkout@v4
- uses: dorny/paths-filter@v3
id: filter <----
with:
filters: |
integration_tests_required:
- '!**/*.md'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Currently, integration tests run on every PR. This takes a considerable amount of time, up to around an hour and 15 minutes. When a change only affects the
docs/directory, there is no need to run integration tests, as that directory only includes the public documentation and user guides. Thus, integration tests can be skipped.Tests
make testrun locallydocs/folderinternal/acceptance